﻿// Copyright © 2010 onwards, Andrew Whewell
// All rights reserved.
//
// Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
//    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//    * Neither the name of the author nor the names of the program's contributors may be used to endorse or promote products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OF THE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace VirtualRadar.Interface.Settings
{
    /// <summary>
    /// The interface for objects that can read the content of a plugin's manifest file.
    /// </summary>
    public interface IPluginManifestStorage
    {
        /// <summary>
        /// Gets or sets the object that abstracts away the environment for tests.
        /// </summary>
        IPluginManifestStorageProvider Provider { get; set; }

        /// <summary>
        /// Loads the manifest file for a plugin.
        /// </summary>
        /// <param name="pluginFileName">The full path to a plugin file (e.g. c:\folder\plugin.dll)</param>
        /// <returns>The content of the manifest file or null if the plugin file does not exist.</returns>
        /// <remarks>
        /// The manifest file is an XML file, see the notes against <see cref="PluginManifest"/> file for more
        /// details. If the file exists but could not be parsed then an exception is thrown - the precise exception
        /// will depend on how the parsing of the XML is performed, in theory it could be anything.
        /// </remarks>
        PluginManifest LoadForPlugin(string pluginFileName);
    }
}
